home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / olrdrs / cvtq110.zip / CVTQ.DOC < prev    next >
Text File  |  1990-10-10  |  38KB  |  734 lines
  1.  ──────────────────────────────────────────────────────────────────────────────
  2.  ██▌ ▐▌█  ██▌                 CONVERT-Q 1.1 MANUAL
  3.  █▐█ ▐▌█ ▐█▐▌               - - - - - - - - - - - - -
  4.  █ █▌▐▌█ █▌▐▌  NuWaiv          Copyright (c) 1990
  5.  █ ▐█▐▌█▐█ ▐▌Software     Ian J. Molee, NuWaiv Software
  6.  █  ██▌██▌ ▐▌
  7.  ──────────────────────────────────────────────────────────────────────────────
  8.  
  9.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  10.                               Table of Contents
  11.  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  12.  
  13. Topic:                                                           Page #:
  14.  
  15. INTRODUCTION ......................................................  1
  16.     What is it? ...................................................  1
  17.     Legal Stuff ...................................................  1
  18. GENERAL USE .......................................................  2
  19.     How's it work? ................................................  2
  20.     Installation ..................................................  3
  21.     The Quotation-Prefix-Layout File ..............................  3
  22.     Command-Line Syntax ...........................................  6
  23. OPTIONS AVAILABLE BY USE OF DOS ENVIRONMENT VARIABLES .............  7
  24.     Quiet, Please .................................................  7
  25.     Space Stripping ...............................................  7
  26.     Sign Off ......................................................  7
  27. MISCELLANEOUS INFORMATION .........................................  9
  28.     DOS Errorlevels ...............................................  9
  29.     Sample Quote-Prefix-Layout Files ..............................  9
  30.     ASCII Table ................................................... 11
  31.     You rang..? ................................................... 13
  32.     Thanks, guys .................................................. 13
  33. REVISION HISTORY .................................................. 14
  34. TRADEMARKS AND COPYRIGHTS ......................................... 14
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.   =================== ConvertQ Documentation          i ======================
  45.  
  46.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  47.                                  Introduction
  48.  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  49.  
  50. ■■■ WHAT IS IT? ■■■
  51.  
  52.     ConvertQ was designed to pretty up any message you can write with an
  53. offline reader which makes use of the pretty much standard "??>" quoting
  54. system: the quotee's initials followed by a greater than (">") sign, thereby
  55. "pointing" to the quotee's words.  While quite functional, the "??>" style gets
  56. old and ugly quite quickly, especially for those who like to stand out in a
  57. crowd, which becomes increasingly difficult via an electronic medium in which
  58. everyone appears as bits and bytes.
  59.  
  60. IM>     Text such as this is usually easily recognizable as a quotation, but
  61. IM>every once in a while, it blends in with the context of the recipient's
  62. IM>message, and it doesn't look attractive compared to some of the more
  63. IM>elaborate designs one could easily conjure up in one's head.  For example,
  64. IM>how about something like
  65.  
  66. IM┤THIS?  Now not only does this stand out more, but it looks prettier, for
  67.   │those of you who are concerned with the appearance of things. However, this
  68.   │may not be everyone's cup of tea.  Perhaps you prefer something more
  69.   │"traditional," like
  70.  
  71. IM>  THIS?  While this still incorporates all the characters of the "??>"
  72.      method, it does not repeat the initials on each and every line, which
  73.      increases the quote's appearance as a "block" rather than a group of
  74.      lines which have been gathered together.
  75.  
  76.     ConvertQ can handle all of the above designs, and countless more.  The
  77. appearances of quotations are all handled through use of a simple, configurable
  78. text file.  For those of you who have the "'??>' Blues," ConvertQ is for you...
  79.  ──────────────────────────────────────────────────────────────────────────────
  80.  
  81. ■■■ LEGAL STUFF ■■■
  82.  
  83.     ConvertQ is being distributed as Freeware.  (However, after writing these
  84. damn documents for lord-knows-how-long, I feel I ought to charge a slight
  85. registration for the DOCUMENTATION! <grin>)  Feel free to make copies of it
  86. and distribute it, so long as no fee is charged for the program itself.
  87. ConvertQ is copyrighted material and may not be modified in any way, shape, or
  88. form, without the author's consent.
  89.  
  90. DISCLAIMER:
  91.     UNDER NO CIRCUMSTANCES SHALL THE AUTHOR BE RESPONSIBLE FOR ANY DIRECT OR
  92. INDIRECT DAMAGE DUE TO USE OF THIS PROGRAM.  NO WARRANTIES, EITHER EXPRESSED
  93. OR IMPLIED, ARE GIVEN.
  94.  
  95. ======================= ConvertQ Documentation      1
  96.  
  97.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  98.                                  General Use
  99.  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  100.  
  101.  ──────────────────────────────────────────────────────────────────────────────
  102.  
  103. ■■■ HOW'S IT WORK? ■■■
  104.  
  105.     The principle of ConvertQ is very simple:  find quotes and alter them.
  106. It's very easy to implement, too; it's just that either no one has cared enough
  107. or no one has thought about enhanced-quotes enough to actually do something
  108. about it.  I thought I'd change that.  What it does, quite simply, is find the
  109. file to translate passed to it on the command line, find the quotation-prefix-
  110. layout file, also passed to it on the command line, read in the quotation-
  111. prefix information, then search through the message file, looking for quotes
  112. (recognized by two capital letters followed by a ">") and translating them
  113. according to the quotation-prefix-layout file (more on that later).
  114.  
  115.     ConvertQ has several additional features, though:
  116.  
  117.         · ConvertQ will preserve the original filetime and filedate
  118.             found on the file you are translating, so anything that
  119.             deals with the file's time/date will not be interfered
  120.             with.
  121.  
  122.         · ConvertQ can word-wrap quotations at a user-specified right
  123.             margin, which can be as low as 40 or as high as 80.  Con-
  124.             vertQ will only wrap quotes if the user so desires.
  125.  
  126.         · ConvertQ can make all lines of a quotation block flush
  127.             left, to enhance the appearance of a quotation.
  128.  
  129.         · ConvertQ can optionally add a signature to the end of the
  130.             message file, or add an entire signature =file= to the
  131.             end of the message file, optionally having the time and
  132.             [configurable] date in the signature.
  133.  
  134.         · ConvertQ will recognize "S>" as a valid quote, since some
  135.             readers will quote the sysop of the BBS as "S>", and not
  136.             a two-letter combination, which ConvertQ =requires= to
  137.             work correctly.  The output generated from a sysop's
  138.             quote will have the initials "SO", for [S]ystem [O]per-
  139.             ator.
  140.  
  141.  
  142. ======================= ConvertQ Documentation      2
  143.  ──────────────────────────────────────────────────────────────────────────────
  144.  
  145. ■■■ INSTALLATION ■■■
  146.  
  147.     The most simple way to install ConvertQ is to create a batch file which is
  148. called by your reader when you select the reply function of your mail reader.
  149. Here's an example to get you started:
  150.  
  151. REPLY.BAT
  152. ▀▀▀▀▀▀▀▀▀
  153. echo off
  154. EDIT.EXE %1 %2
  155. CVTQ -m0 %1 PREFIX.FIL
  156.  
  157.     Don't worry about the command-line arguments you see above for the file
  158. CVTQ yet; they will be discussed in greater detail later.  If you use only one
  159. file to reply to a message, the "%2" on the line which calls the editor is not
  160. necessary, and you need only pass the name of the single file with the command
  161. which invokes the reply batch file.  For example, "REPLY MESSAGE.TXT" would
  162. call REPLY.BAT with MESSAGE.TXT as the single file you're going to use.
  163. Otherwise, pass both filenames, with the reply filename first and the original
  164. message filename second, as only the first file will be processed by CVTQ (in
  165. this batch file).
  166.  ────────